// Licensed to Cloudera, Inc. under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  Cloudera, Inc. licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.cloudera.csd.descriptors.generators;

import org.hibernate.validator.constraints.NotBlank;

/**
 * This config generator specifies arbitrary
 * configuration files to be created. The generator
 * either creates an empty configuration file or
 * copies the contents from another source file.
 * In either case, safety valves are automatically
 * created for files.
 */
public interface AuxConfigGenerator {

  /**
   * The name of the configuration file.
   */
  @NotBlank
  String getFilename();

  /**
   * The auxiliary file to copy when writing out
   * the configuration file. This is optional and
   * if not specified, an empty file is written out
   * unless the user has added to the safety valve
   * in Cloudera Manager.
   */
  String getSourceFilename();
}
